Daemon.jsonrpc_get: add download_collection option for handling collections
#3415
+75
−16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@lyoshenka please review the API changes |
…lections
Normally, if a particular claim is in fact a collection (playlist),
it will not be downloaded, as it is not a stream.
```
lbrynet get collection-claim
```
Will result in
```
{
"error": "Claim is not a stream."
}
```
To resolve the collection, and download the claims that it contains
we can use the option `--download_collection`.
```
lbrynet get collection-claim --download_collection
```
A collection can have an arbitrary number of items, so to limit
the number of claims to download we can use `--max_claims`.
```
lbrynet get collection-claim --download_collection --max_claims=4
```
To reverse the order of the claims in the collection
use `--reverse_collection`. This can be used to get the newest
items in the collection.
```
lbrynet get collection-claim --download_collection --max_claims=10 --reverse_collection
```
belikor
force-pushed
the
get-collection
branch
from
c57acfd
to
b2f8327
Compare
lyoshenka
requested changes
Oct 4, 2021
There was a problem hiding this comment.
There's no need for a --download_collection flag. If you call get on a collection, then you want to download the collection.
I'd rename --max_claims to --collection_limit so it's clear that flag applies to collections.
Otherwise the API looks good to me. @eukreign please review the code itself once @belikor makes these changes.
|
@belikor planning to come back to this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This can be combined with #3411, but in this pull request we only show the code to handle collections.
Normally, if a particular claim is in fact a collection (playlist), it will not be downloaded, as it is not a stream.
Will result in
To resolve the collection, and download the claims that it contains we can use a new option
--download_collection.A collection can have an arbitrary number of items, so to limit the number of claims to download we can use
--max_claims.To reverse the order of the claims in the collection use
--reverse_collection. This can be used to get the newest items in the collection.The inner code to download a URL is put in its own method
_get, then the collection is parsed, and_getis used on each of the internal claims.After merging #3411, we can refactor this pull request to be able to use a claim ID.